home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / usenet / sources / volume91 / utilitys / ed3_1_1 / part01 / ed3.readme < prev    next >
Text File  |  1991-11-07  |  10KB  |  227 lines
  1.  
  2. -------------------------------------------------------------------
  3. ED3, a primitive 3D editor for use with NU3, a primitive 3D viewer.
  4. -------------------------------------------------------------------
  5.  
  6. This is version 1.1, the 1st real release.  There is a lot of work left to do.
  7. This version is placed in the public domain by it's author, Ben Discoe.
  8. The author is a firm believer in the hacker ethic.  Use at your own risk.  If
  9. you like this program, use it, use pieces of its code, or even find it
  10. vaguely interesting, please let me know!
  11.  
  12. The main purpose of this program is to play with polyhedra and "geodesic"
  13. structures.  However, it is very general-purpose so you could use it for any
  14. sort of 3D world-design.  The only other 3D editor I have ever used is the
  15. one in Sculpt-3D (back in 1987) so I don't know how they might compare to
  16. ed3.  The files that ed3 loads and saves are not in any standard format,
  17. so you can't just load Sculpt, Imagine or Turbo Silver objects.
  18.  
  19. ed3 can compile into a integer version or a floating-point version.  The
  20. floating-point version is highly recommended for people with fast CPUs,
  21. math coprocessors, or the need for high accuracy.
  22.  
  23. Before running: make sure you have the req.library in your LIBS:
  24. directory.  It's included in this archive case you don't have it already.
  25.  
  26. There's only one command line option: -w will start ed3 on your workbench
  27. screen.  Sorry, Workbench fans, no ToolTypes stuff.
  28.  
  29. I've just realized that the program has developed completely lacking
  30. documentation, so I'll now make a doomed attempt to at least notify you of
  31. what features are available:
  32.  
  33. *****************************************************************************
  34.  
  35.     G A D G E T S
  36.  
  37. ADD    Puts you in Add Point mode.  Click either button to add points.
  38.  
  39. DELETE    Puts you in Delete Point mode.  Click to delete points - which
  40.     button you use affects things - see below.
  41.  
  42. SELECTOR This gives you the selector tool, which selects/deselects points.
  43.     Double-click to select-connected (or deselect-connected).
  44.  
  45. MOVE    Puts you in Move mode.  Click to select a point, shift-click to
  46.     select more points.  Once the points are selected, you can drag
  47.     to move them.
  48.  
  49. FACE    Puts you in Add Face mode.  A Face in ED3 means a triangular face.
  50.     In this mode, click on any three points to create a Face.
  51.  
  52. POLY    Puts you in Add Polygon mode.  A Polygon in ED3 means a polygon
  53.     with more than 3 vertices.  This distinction between Faces and
  54.     Polygons is important to programs that, for example, only
  55.     support planar faces.
  56.  
  57. (ADDP)    You are put in this mode when connecting points for a Face or
  58.     Polygon.
  59.  
  60. DEFACE    Lets you specify three points to remove a Face.
  61.  
  62. DEFACE    Lets you specify N points to remove a Poly.
  63.  
  64. ROTATE    In Rotate mode, click once to specify the axis of rotation,
  65.     then move the mouse around this point to the desired angle
  66.     and click once more.  All points will rotate.
  67.  
  68. ZOOM    Lets you change the degree of magnification.  In Zoom mode, click
  69.     the first button to zoom in towards a location, second button to
  70.     zoom out away from a location.  Try it, it's one of my favorite
  71.     features.
  72.  
  73. DISTANCE The Distance tool is a "ruler" for measuring distance in 3D space.
  74.     Both ends can be dragged around, or "attached" to points by
  75.     double-clicking near the intended point.  The distance (length
  76.     of the distance tool) appears in the upper right corner.
  77.  
  78. GLUE    Glue will "merge" the the point closest to the pointer and the
  79.     point closest to it.  All degenerations are handled correctly.
  80.  
  81. UNDO    If you find a bug in Undo/Redo, let me know.  It's a fairly
  82. REDO    tricky feature.  It's also fairly uncommon in 3d editors.
  83.  
  84. XY, XZ, YZ    Specify the orthogonal direction of view.
  85.  
  86. > 3D <    Currently, viewing your object from a 3D perspective requires
  87.     a separate program, NU3, which supports several different
  88.     hidden-line algorithms.  Someday this capability may merge
  89.     with ED3.
  90.  
  91. COLOR gadgets.  These affect the color of the faces you define which is
  92.     only displayed by the 3D viewer NU3.
  93.  
  94. *****************************************************************************
  95.  
  96.     M E N U S
  97.  
  98. Since the right button is used to select points, the pointer must be over
  99. the menu bar to access the menus.
  100. Menu options:
  101.  
  102. PROJECT Normal stuff.  "Save Defaults" saves the settings of the "Options"
  103.     menu to a file called ed3-defs, which is automatically loaded the
  104. next time you start.
  105.  
  106. EDIT    No clipboard support yet.  The Duplicate menu makes an exact in-place
  107.     copy of all selected points and the facets connecting them.  Erase
  108. kills the selected points and the facets connecting them.  The bottom three
  109. options aren't completely implemented.
  110.  
  111. POLYHEDRA    These are some basic polyhedra.  You can use them as
  112.         starting points for constructing really wild, complex
  113. polyhedra using the special features described below.
  114.  
  115. SPECIAL
  116. -------
  117. FREQUENCY    This is one of the two Really Neat features of ED3.
  118.         This will divide each triangular (or quadrilateral) face into
  119. a set of smaller triangles, where the number of resultant triangles is
  120. frequency squared.  Try this on your favorite polyhedra, then Normalize to
  121. get pseudo-geodesic structures.  The reason why I say psuedo is because if
  122. you use this method with any ODD frequency, the resulting location of
  123. vertices does not truly correlate to subdiving the geodesicic arcs described
  124. by the polyhefron edges.  It is, however, very close, close enough for a
  125. crude program such as ED3.  You could theoretically raise a form to any large
  126. frequency, although you are, naturally, limited by your memory size.
  127.  
  128. FIND DUAL    This is the second Really Neat feature.
  129.         Every fully-connected polyhedron has a dual, which is formed
  130. by exchanging the configuration of faces with vertices.  For example, the
  131. cube's dual is the octahedron, and the icosahedron's dual is the pentagon
  132. dodecahedon.  Complex geodesic structures also have their duals, which are
  133. typically complex "fly's eye" structures involving many hexagons.  Naturally,
  134. a dual of a dual is the original shape.
  135.  
  136. UNFOLD        This is a future Really Neat feature.
  137.  
  138. NORMALIZE    This finds the center of all points and adjusts all points
  139.         to lie the average distance from that center.  Simply stated,
  140. it makes all points Spherical.  Use to project flat tesselated faces onto
  141. their geodesics.
  142.  
  143. STELLATE    This will take every face and make a pyramid out of it,
  144.         giving a "3D star" based on whatever shape you are using.
  145. Combining this feature with "Find Dual" can be used to form truncated forms
  146. of polyhedra.  Try it.
  147.  
  148. CENTER->ORIGIN    Moves all points so that their vector sum is centered on the
  149.         origin.
  150.  
  151. OPTIONS
  152. -------
  153. ASSUME POLYHEDRON tell the features on the Special menu (notably Find Dual
  154.         and Normalize) to assume that the shape you're working with
  155.         is a polyhedron.  Set this option whenever you DO have a
  156.         polyhedron.
  157.  
  158. ROTATE EVERYTHING tells the rotate command to rotate all points, not only
  159.         the selected points.
  160.  
  161. UNDO BUFFER ACTIVE turns the undo/redo buffer on or off.  If you playing with
  162.         very large shapes or have little memory, you may want to
  163.         turn this off.
  164.  
  165. SET UNDO BUFFER SIZE will affect the undo buffer only at the next time you
  166.         start ed3 - it doesn't change or damage your current undo
  167.         buffer.
  168.  
  169.  
  170. (A 3D CONVEX HULL algorithm is yet another future Really Neat feature)
  171.  
  172. *****************************************************************************
  173.  
  174. More functionality available from the keyboard:
  175.  
  176.   ESC    Quits.
  177.     C    Toggles the crosshair.
  178.     D    Toggles the distance tool.
  179.     M    Same as the Move button.
  180.     U    Same as Undo button.
  181.     R    Same as Redo button.
  182. 8 and 2    The ED3 "pointer" really exists in 3 dimensions, as its location is
  183.     displayed near the title bar.  8 and 2 (chosen for their location in
  184.     the keypad) move the pointer "far" and "near", in whatever direction
  185.     isn't available using the mouse.
  186. SHIFT    Used to multiple-select points (just like a GUI should) in MOVE mode.
  187. SPACE BAR    This is a commonly used key!  Since your structure can get
  188.     very large, you may not want to refresh the screen after every
  189.     operation, especially on a 68000 machine.  Therefore, redraw is
  190.     triggered by the space bar so it occurs only when you want it to.
  191.  
  192. *****************************************************************************
  193.  
  194. On the use of the Left and Right Mouse Buttons to select points:
  195.  
  196. LEFT button will select the point closest to the pointer ON THE SCREEN,
  197. RIGHT button will select the point closest IN 3D SPACE to the 3D location of
  198.     the ED3 pointer.  This is tricky to use, but essential when you've
  199.     got lots of points that are othogonal to the 3D axes, making the Left
  200.     button unreliable.  I typically Rotate the structure instead, giving
  201.     each point a unique mapping onto the screen, then use the left
  202.     button.
  203.  
  204. *****************************************************************************
  205.  
  206. About the Author
  207. ----------------
  208.   I dropped out of Caltech for two reasons.  First, my brain fried on the
  209. Quantum Physics and EE (i'm a programmer, not a physicist).  Second, I was
  210. spending too much time with my hobby, 3D geometry, which no one was
  211. interested in teaching me about.  ED3 and NU3 were projects that evolved out
  212. of this hobby and were written casually during a few months of unemployment
  213. in Berkeley in early summer 1990.  I recently revived them, added a ton
  214. of stuff, and released 1.0.
  215.  
  216.   I am currently (10/17/91) employed (and reachable) at
  217.  
  218. preferably: rodent@netcom.com (a public-access site)
  219.  
  220. Ben Discoe
  221. Versasoft Corp.
  222. 4340 Almaden Expr. #110
  223. San Jose, CA 95118
  224.  
  225. Read ED3.tech (and the source) for technical notes.
  226.  
  227.